dbDir = isset( $p['dbDirectory'] ) ? $p['dbDirectory'] : $wgSQLiteDataDir; if ( isset( $p['dbFilePath'] ) ) { parent::__construct( $p ); // Standalone .sqlite file mode. // Super doesn't open when $user is false, but we can work with $dbName, // which is derived from the file path in this case. $this->openFile( $p['dbFilePath'] ); } else { $this->mDBname = $p['dbname']; // Stock wiki mode using standard file names per DB. parent::__construct( $p ); // Super doesn't open when $user is false, but we can work with $dbName if ( $p['dbname'] && !$this->isOpen() ) { if ( $this->open( $p['host'], $p['user'], $p['password'], $p['dbname'] ) ) { $done = []; foreach ( $this->tableAliases as $params ) { if ( isset( $done[$params['dbname']] ) ) { continue; } $this->attachDatabase( $params['dbname'] ); $done[$params['dbname']] = 1; } } } } $this->trxMode = isset( $p['trxMode'] ) ? strtoupper( $p['trxMode'] ) : null; if ( $this->trxMode && !in_array( $this->trxMode, [ 'DEFERRED', 'IMMEDIATE', 'EXCLUSIVE' ] ) ) { $this->trxMode = null; wfWarn( "Invalid SQLite transaction mode provided." ); } $this->lockMgr = new FSLockManager( [ 'lockDirectory' => "{$this->dbDir}/locks" ] ); } /** * @param string $filename * @param array $p Options map; supports: * - flags : (same as __construct counterpart) * - trxMode : (same as __construct counterpart) * - dbDirectory : (same as __construct counterpart) * @return DatabaseSqlite * @since 1.25 */ public static function newStandaloneInstance( $filename, array $p = [] ) { $p['dbFilePath'] = $filename; $p['schema'] = false; $p['tablePrefix'] = ''; return DatabaseBase::factory( 'sqlite', $p ); } /** * @return string */ function getType() { return 'sqlite'; } /** * @todo Check if it should be true like parent class * * @return bool */ function implicitGroupby() { return false; } /** Open an SQLite database and return a resource handle to it * NOTE: only $dbName is used, the other parameters are irrelevant for SQLite databases * * @param string $server * @param string $user * @param string $pass * @param string $dbName * * @throws DBConnectionError * @return PDO */ function open( $server, $user, $pass, $dbName ) { $this->close(); $fileName = self::generateFileName( $this->dbDir, $dbName ); if ( !is_readable( $fileName ) ) { $this->mConn = false; throw new DBConnectionError( $this, "SQLite database not accessible" ); } $this->openFile( $fileName ); return $this->mConn; } /** * Opens a database file * * @param string $fileName * @throws DBConnectionError * @return PDO|bool SQL connection or false if failed */ protected function openFile( $fileName ) { $err = false; $this->dbPath = $fileName; try { if ( $this->mFlags & DBO_PERSISTENT ) { $this->mConn = new PDO( "sqlite:$fileName", '', '', [ PDO::ATTR_PERSISTENT => true ] ); } else { $this->mConn = new PDO( "sqlite:$fileName", '', '' ); } } catch ( PDOException $e ) { $err = $e->getMessage(); } if ( !$this->mConn ) { wfDebug( "DB connection error: $err\n" ); throw new DBConnectionError( $this, $err ); } $this->mOpened = !!$this->mConn; if ( $this->mOpened ) { # Set error codes only, don't raise exceptions $this->mConn->setAttribute( PDO::ATTR_ERRMODE, PDO::ERRMODE_SILENT ); # Enforce LIKE to be case sensitive, just like MySQL $this->query( 'PRAGMA case_sensitive_like = 1' ); return $this->mConn; } return false; } /** * @return string SQLite DB file path * @since 1.25 */ public function getDbFilePath() { return $this->dbPath; } /** * Does not actually close the connection, just destroys the reference for GC to do its work * @return bool */ protected function closeConnection() { $this->mConn = null; return true; } /** * Generates a database file name. Explicitly public for installer. * @param string $dir Directory where database resides * @param string $dbName Database name * @return string */ public static function generateFileName( $dir, $dbName ) { return "$dir/$dbName.sqlite"; } /** * Check if the searchindext table is FTS enabled. * @return bool False if not enabled. */ function checkForEnabledSearch() { if ( self::$fulltextEnabled === null ) { self::$fulltextEnabled = false; $table = $this->tableName( 'searchindex' ); $res = $this->query( "SELECT sql FROM sqlite_master WHERE tbl_name = '$table'", __METHOD__ ); if ( $res ) { $row = $res->fetchRow(); self::$fulltextEnabled = stristr( $row['sql'], 'fts' ) !== false; } } return self::$fulltextEnabled; } /** * Returns version of currently supported SQLite fulltext search module or false if none present. * @return string */ static function getFulltextSearchModule() { static $cachedResult = null; if ( $cachedResult !== null ) { return $cachedResult; } $cachedResult = false; $table = 'dummy_search_test'; $db = self::newStandaloneInstance( ':memory:' ); if ( $db->query( "CREATE VIRTUAL TABLE $table USING FTS3(dummy_field)", __METHOD__, true ) ) { $cachedResult = 'FTS3'; } $db->close(); return $cachedResult; } /** * Attaches external database to our connection, see http://sqlite.org/lang_attach.html * for details. * * @param string $name Database name to be used in queries like * SELECT foo FROM dbname.table * @param bool|string $file Database file name. If omitted, will be generated * using $name and configured data directory * @param string $fname Calling function name * @return ResultWrapper */ function attachDatabase( $name, $file = false, $fname = __METHOD__ ) { if ( !$file ) { $file = self::generateFileName( $this->dbDir, $name ); } $file = $this->addQuotes( $file ); return $this->query( "ATTACH DATABASE $file AS $name", $fname ); } function isWriteQuery( $sql ) { return parent::isWriteQuery( $sql ) && !preg_match( '/^(ATTACH|PRAGMA)\b/i', $sql ); } /** * SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result * * @param string $sql * @return bool|ResultWrapper */ protected function doQuery( $sql ) { $res = $this->mConn->query( $sql ); if ( $res === false ) { return false; } else { $r = $res instanceof ResultWrapper ? $res->result : $res; $this->mAffectedRows = $r->rowCount(); $res = new ResultWrapper( $this, $r->fetchAll() ); } return $res; } /** * @param ResultWrapper|mixed $res */ function freeResult( $res ) { if ( $res instanceof ResultWrapper ) { $res->result = null; } else { $res = null; } } /** * @param ResultWrapper|array $res * @return stdClass|bool */ function fetchObject( $res ) { if ( $res instanceof ResultWrapper ) { $r =& $res->result; } else { $r =& $res; } $cur = current( $r ); if ( is_array( $cur ) ) { next( $r ); $obj = new stdClass; foreach ( $cur as $k => $v ) { if ( !is_numeric( $k ) ) { $obj->$k = $v; } } return $obj; } return false; } /** * @param ResultWrapper|mixed $res * @return array|bool */ function fetchRow( $res ) { if ( $res instanceof ResultWrapper ) { $r =& $res->result; } else { $r =& $res; } $cur = current( $r ); if ( is_array( $cur ) ) { next( $r ); return $cur; } return false; } /** * The PDO::Statement class implements the array interface so count() will work * * @param ResultWrapper|array $res * @return int */ function numRows( $res ) { $r = $res instanceof ResultWrapper ? $res->result : $res; return count( $r ); } /** * @param ResultWrapper $res * @return int */ function numFields( $res ) { $r = $res instanceof ResultWrapper ? $res->result : $res; if ( is_array( $r ) && count( $r ) > 0 ) { // The size of the result array is twice the number of fields. (Bug: 65578) return count( $r[0] ) / 2; } else { // If the result is empty return 0 return 0; } } /** * @param ResultWrapper $res * @param int $n * @return bool */ function fieldName( $res, $n ) { $r = $res instanceof ResultWrapper ? $res->result : $res; if ( is_array( $r ) ) { $keys = array_keys( $r[0] ); return $keys[$n]; } return false; } /** * Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks * * @param string $name * @param string $format * @return string */ function tableName( $name, $format = 'quoted' ) { // table names starting with sqlite_ are reserved if ( strpos( $name, 'sqlite_' ) === 0 ) { return $name; } return str_replace( '"', '', parent::tableName( $name, $format ) ); } /** * Index names have DB scope * * @param string $index * @return string */ protected function indexName( $index ) { return $index; } /** * This must be called after nextSequenceVal * * @return int */ function insertId() { // PDO::lastInsertId yields a string :( return intval( $this->mConn->lastInsertId() ); } /** * @param ResultWrapper|array $res * @param int $row */ function dataSeek( $res, $row ) { if ( $res instanceof ResultWrapper ) { $r =& $res->result; } else { $r =& $res; } reset( $r ); if ( $row > 0 ) { for ( $i = 0; $i < $row; $i++ ) { next( $r ); } } } /** * @return string */ function lastError() { if ( !is_object( $this->mConn ) ) { return "Cannot return last error, no db connection"; } $e = $this->mConn->errorInfo(); return isset( $e[2] ) ? $e[2] : ''; } /** * @return string */ function lastErrno() { if ( !is_object( $this->mConn ) ) { return "Cannot return last error, no db connection"; } else { $info = $this->mConn->errorInfo(); return $info[1]; } } /** * @return int */ function affectedRows() { return $this->mAffectedRows; } /** * Returns information about an index * Returns false if the index does not exist * - if errors are explicitly ignored, returns NULL on failure * * @param string $table * @param string $index * @param string $fname * @return array */ function indexInfo( $table, $index, $fname = __METHOD__ ) { $sql = 'PRAGMA index_info(' . $this->addQuotes( $this->indexName( $index ) ) . ')'; $res = $this->query( $sql, $fname ); if ( !$res ) { return null; } if ( $res->numRows() == 0 ) { return false; } $info = []; foreach ( $res as $row ) { $info[] = $row->name; } return $info; } /** * @param string $table * @param string $index * @param string $fname * @return bool|null */ function indexUnique( $table, $index, $fname = __METHOD__ ) { $row = $this->selectRow( 'sqlite_master', '*', [ 'type' => 'index', 'name' => $this->indexName( $index ), ], $fname ); if ( !$row || !isset( $row->sql ) ) { return null; } // $row->sql will be of the form CREATE [UNIQUE] INDEX ... $indexPos = strpos( $row->sql, 'INDEX' ); if ( $indexPos === false ) { return null; } $firstPart = substr( $row->sql, 0, $indexPos ); $options = explode( ' ', $firstPart ); return in_array( 'UNIQUE', $options ); } /** * Filter the options used in SELECT statements * * @param array $options * @return array */ function makeSelectOptions( $options ) { foreach ( $options as $k => $v ) { if ( is_numeric( $k ) && ( $v == 'FOR UPDATE' || $v == 'LOCK IN SHARE MODE' ) ) { $options[$k] = ''; } } return parent::makeSelectOptions( $options ); } /** * @param array $options * @return string */ protected function makeUpdateOptionsArray( $options ) { $options = parent::makeUpdateOptionsArray( $options ); $options = self::fixIgnore( $options ); return $options; } /** * @param array $options * @return array */ static function fixIgnore( $options ) { # SQLite uses OR IGNORE not just IGNORE foreach ( $options as $k => $v ) { if ( $v == 'IGNORE' ) { $options[$k] = 'OR IGNORE'; } } return $options; } /** * @param array $options * @return string */ function makeInsertOptions( $options ) { $options = self::fixIgnore( $options ); return parent::makeInsertOptions( $options ); } /** * Based on generic method (parent) with some prior SQLite-sepcific adjustments * @param string $table * @param array $a * @param string $fname * @param array $options * @return bool */ function insert( $table, $a, $fname = __METHOD__, $options = [] ) { if ( !count( $a ) ) { return true; } # SQLite can't handle multi-row inserts, so divide up into multiple single-row inserts if ( isset( $a[0] ) && is_array( $a[0] ) ) { $ret = true; foreach ( $a as $v ) { if ( !parent::insert( $table, $v, "$fname/multi-row", $options ) ) { $ret = false; } } } else { $ret = parent::insert( $table, $a, "$fname/single-row", $options ); } return $ret; } /** * @param string $table * @param array $uniqueIndexes Unused * @param string|array $rows * @param string $fname * @return bool|ResultWrapper */ function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) { if ( !count( $rows ) ) { return true; } # SQLite can't handle multi-row replaces, so divide up into multiple single-row queries if ( isset( $rows[0] ) && is_array( $rows[0] ) ) { $ret = true; foreach ( $rows as $v ) { if ( !$this->nativeReplace( $table, $v, "$fname/multi-row" ) ) { $ret = false; } } } else { $ret = $this->nativeReplace( $table, $rows, "$fname/single-row" ); } return $ret; } /** * Returns the size of a text field, or -1 for "unlimited" * In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. No way to query it though. * * @param string $table * @param string $field * @return int */ function textFieldSize( $table, $field ) { return -1; } /** * @return bool */ function unionSupportsOrderAndLimit() { return false; } /** * @param string $sqls * @param bool $all Whether to "UNION ALL" or not * @return string */ function unionQueries( $sqls, $all ) { $glue = $all ? ' UNION ALL ' : ' UNION '; return implode( $glue, $sqls ); } /** * @return bool */ function wasDeadlock() { return $this->lastErrno() == 5; // SQLITE_BUSY } /** * @return bool */ function wasErrorReissuable() { return $this->lastErrno() == 17; // SQLITE_SCHEMA; } /** * @return bool */ function wasReadOnlyError() { return $this->lastErrno() == 8; // SQLITE_READONLY; } /** * @return string Wikitext of a link to the server software's web site */ public function getSoftwareLink() { return "[{{int:version-db-sqlite-url}} SQLite]"; } /** * @return string Version information from the database */ function getServerVersion() { $ver = $this->mConn->getAttribute( PDO::ATTR_SERVER_VERSION ); return $ver; } /** * @return string User-friendly database information */ public function getServerInfo() { return wfMessage( self::getFulltextSearchModule() ? 'sqlite-has-fts' : 'sqlite-no-fts', $this->getServerVersion() )->text(); } /** * Get information about a given field * Returns false if the field does not exist. * * @param string $table * @param string $field * @return SQLiteField|bool False on failure */ function fieldInfo( $table, $field ) { $tableName = $this->tableName( $table ); $sql = 'PRAGMA table_info(' . $this->addQuotes( $tableName ) . ')'; $res = $this->query( $sql, __METHOD__ ); foreach ( $res as $row ) { if ( $row->name == $field ) { return new SQLiteField( $row, $tableName ); } } return false; } protected function doBegin( $fname = '' ) { if ( $this->trxMode ) { $this->query( "BEGIN {$this->trxMode}", $fname ); } else { $this->query( 'BEGIN', $fname ); } $this->mTrxLevel = 1; } /** * @param string $s * @return string */ function strencode( $s ) { return substr( $this->addQuotes( $s ), 1, -1 ); } /** * @param string $b * @return Blob */ function encodeBlob( $b ) { return new Blob( $b ); } /** * @param Blob|string $b * @return string */ function decodeBlob( $b ) { if ( $b instanceof Blob ) { $b = $b->fetch(); } return $b; } /** * @param Blob|string $s * @return string */ function addQuotes( $s ) { if ( $s instanceof Blob ) { return "x'" . bin2hex( $s->fetch() ) . "'"; } elseif ( is_bool( $s ) ) { return (int)$s; } elseif ( strpos( $s, "\0" ) !== false ) { // SQLite doesn't support \0 in strings, so use the hex representation as a workaround. // This is a known limitation of SQLite's mprintf function which PDO // should work around, but doesn't. I have reported this to php.net as bug #63419: // https://bugs.php.net/bug.php?id=63419 // There was already a similar report for SQLite3::escapeString, bug #62361: // https://bugs.php.net/bug.php?id=62361 // There is an additional bug regarding sorting this data after insert // on older versions of sqlite shipped with ubuntu 12.04 // https://phabricator.wikimedia.org/T74367 wfDebugLog( __CLASS__, __FUNCTION__ . ': Quoting value containing null byte. ' . 'For consistency all binary data should have been ' . 'first processed with self::encodeBlob()' ); return "x'" . bin2hex( $s ) . "'"; } else { return $this->mConn->quote( $s ); } } /** * @return string */ function buildLike() { $params = func_get_args(); if ( count( $params ) > 0 && is_array( $params[0] ) ) { $params = $params[0]; } return parent::buildLike( $params ) . "ESCAPE '\' "; } /** * @param string $field Field or column to cast * @return string * @since 1.28 */ public function buildStringCast( $field ) { return 'CAST ( ' . $field . ' AS TEXT )'; } /** * @return string */ public function getSearchEngine() { return "SearchSqlite"; } /** * No-op version of deadlockLoop * * @return mixed */ public function deadlockLoop( /*...*/ ) { $args = func_get_args(); $function = array_shift( $args ); return call_user_func_array( $function, $args ); } /** * @param string $s * @return string */ protected function replaceVars( $s ) { $s = parent::replaceVars( $s ); if ( preg_match( '/^\s*(CREATE|ALTER) TABLE/i', $s ) ) { // CREATE TABLE hacks to allow schema file sharing with MySQL // binary/varbinary column type -> blob $s = preg_replace( '/\b(var)?binary(\(\d+\))/i', 'BLOB', $s ); // no such thing as unsigned $s = preg_replace( '/\b(un)?signed\b/i', '', $s ); // INT -> INTEGER $s = preg_replace( '/\b(tiny|small|medium|big|)int(\s*\(\s*\d+\s*\)|\b)/i', 'INTEGER', $s ); // floating point types -> REAL $s = preg_replace( '/\b(float|double(\s+precision)?)(\s*\(\s*\d+\s*(,\s*\d+\s*)?\)|\b)/i', 'REAL', $s ); // varchar -> TEXT $s = preg_replace( '/\b(var)?char\s*\(.*?\)/i', 'TEXT', $s ); // TEXT normalization $s = preg_replace( '/\b(tiny|medium|long)text\b/i', 'TEXT', $s ); // BLOB normalization $s = preg_replace( '/\b(tiny|small|medium|long|)blob\b/i', 'BLOB', $s ); // BOOL -> INTEGER $s = preg_replace( '/\bbool(ean)?\b/i', 'INTEGER', $s ); // DATETIME -> TEXT $s = preg_replace( '/\b(datetime|timestamp)\b/i', 'TEXT', $s ); // No ENUM type $s = preg_replace( '/\benum\s*\([^)]*\)/i', 'TEXT', $s ); // binary collation type -> nothing $s = preg_replace( '/\bbinary\b/i', '', $s ); // auto_increment -> autoincrement $s = preg_replace( '/\bauto_increment\b/i', 'AUTOINCREMENT', $s ); // No explicit options $s = preg_replace( '/\)[^);]*(;?)\s*$/', ')\1', $s ); // AUTOINCREMENT should immedidately follow PRIMARY KEY $s = preg_replace( '/primary key (.*?) autoincrement/i', 'PRIMARY KEY AUTOINCREMENT $1', $s ); } elseif ( preg_match( '/^\s*CREATE (\s*(?:UNIQUE|FULLTEXT)\s+)?INDEX/i', $s ) ) { // No truncated indexes $s = preg_replace( '/\(\d+\)/', '', $s ); // No FULLTEXT $s = preg_replace( '/\bfulltext\b/i', '', $s ); } elseif ( preg_match( '/^\s*DROP INDEX/i', $s ) ) { // DROP INDEX is database-wide, not table-specific, so no ON